Working with services

Overview

This article lists the available Dundas BI services and shows how to get service interfaces from the Dundas BI Engine.

How to get Dundas BI services

To get the Dundas BI service interfaces, call the engine's GetService method after first creating and starting the Dundas BI engine.

The example section below demonstrates calling the GetService method for the various services.

List of available Dundas BI services

The following is a list of the Dundas BI services that are available in the Dundas.BI.Core assembly:

• IAccountRegistrationService - Provides methods for submitting and approving account registration requests.
• IAccountService - Methods for performing operations on accounts.
• IAnnotationService - Interface used to work with data annotations.
• IAppConfigService - Service providing access to the application configuration.
• IApplicationInfoService - Provides methods for getting information about the Dundas application.
• IAppResourceService - Provides methods for managing application resources.
• IBroadcastService - Methods for sending broadcast messages.
• ICallerContextService - Provides a means for the Engine to determine which session should be used for currently-executing code.
• ICodeLibraryService - Interface for service providing functionality for CodeLibrary objects.
• IComponentService - Interface used for the process component service factory.
• ICubePerspectiveService - Interface for CubePerspective object persistence.
• ICustomAttributeService - Methods for performing operations on custom attribute.
• IDataConnectorService - Interface for service providing functionality for getting and saving DataConnector objects.
• IDataCubeService - Interface for service providing functionality for DataCube objects.
• IDataInputService - Service interface for data input.
• IDataProviderService - Interface used to list and get data providers.
• IDataRetrievalService - Interface for data retrieval functionality.
• IDataSourceCredentialService - Provides an interface for getting effective data source connection credentials.
• IDateMappingService - Service to create, update, read, delete DateMapping objects.
• IDeliveryProviderService - Interface used to list and get delivery providers.
• IDeliveryService - Interface used to deliver notification content.
• IEmailService - This class provides methods to send emails using the application's configured email settings or a specific set of email settings.
• IEncryptionService - Provides an interface for encrypting and decrypting strings using the secret key from the application database.
• IEventHookService - Provides an interface for raising and handling application events.
• IExportProviderService - Interface used to list and get export providers.
• IExportService - Provides export of dashboards to various formats.
• IExtensionService - Service for registering and enumerating application extensions.
• IFeatureService - Provides methods for getting information about enabled application features.
• IFederatedAuthenticationService - Service interface for federated authentication.
• IFileSystemService - Provides methods for accessing the application file system.
• IGroupService - Methods for performing operations on Groups.
• IHealthService - The interface which provides access to application health functionality.
• IHierarchyService - Interface for service providing functionality related to an IHierarchy object.
• IHttpClientService - Provides the interface to a service which can provide HttpClient instances.
• IJobService - Provides services for accessing and manipulating application jobs.
• ILicenseActivationService - Provides an interface for managing license activation.
• ILicenseService - Provides an interface for managing application licenses.
• ILocalizationService - Provides methods for getting localized versions of strings.
• ILoggingService - Provides methods for application logging/tracing.
• ILogOnService - Provides methods related to logging onto the application.
• IMachineLearningService - Interface used to list and get machine learning providers.
• IMapService - Methods for performing map related actions.
• IMetadataService - Interface used to manage information for DataElementMetadata objects.
• IMetricSetService - Interface for service providing functionality for MetricSet objects.
• IMultiTenancyService - Methods for performing operations on tenants.
• INativeStructureService - Interface for service providing functionality for getting and saving NativeStructure objects.
• INetworkHelperService - Provides low-level networking helper methods.
• INotificationService - Interface for defining and retrieving notifications.
• IOlapCubeService - Interface for service providing functionality for OlapCube objects.
• IParameterService - Interface for passing parameters to the engine without having to serialize and short link the values.
• IPrivilegeService - Methods for performing operations on privilege.
• IProjectService - Provides methods for performing operations on projects.
• IRaggedHierarchyService - Interface for service providing functionality related to RaggedHierarchy objects.
• IRelationshipService - Relationship manager service.
• IResourceFileService - Defining resource files related properties and methods.
• IScheduleService - Provides methods for getting and saving Schedule objects.
• IServerRegistryService - Service interface providing functionality for managing servers and server groups.
• ISessionService - Methods for performing session-related operations.
• IShortLinkService - Provides methods for mapping long link to short link and vice versa.
• ISlideshowService - Interface for service providing functionality for getting and saving Slideshow objects.
• IStyleService - Interface for service providing functionality for getting and saving Style objects.
• IThemeService - Interface for service providing functionality for getting and saving Theme objects.
• ITimeDimensionProviderService - Interface used to list and get time dimension providers.
• ITimeDimensionService - Interface for service providing functionality for getting and saving TimeDimension objects.
• ITokenService - Service interface for token retrieval.
• ITransferService - Methods for performing operations on import and export.
• IUsageTrackingService - Interface for managing the data associated with tracking the usage of views (e.g. dashboards and reports).
• IUserHierarchyService - Interface for service providing functionality related to UserHierarchy objects.
• IViewService - Interface for service providing functionality for getting and saving View objects.
• IWebLinkService - Specifies the interface for a service which can provide information from a hosting web application.

Example

The following samples demonstrate how to get different Dundas BI service interfaces:

IAccountRegistrationService accountRegistrationService = 
	Engine.Current.GetService<IAccountRegistrationService>();

IAccountService accountService = 
	Engine.Current.GetService<IAccountService>();

IAnnotationService annotationService = 
	Engine.Current.GetService<IAnnotationService>();

IAppConfigService appConfigService = 
	Engine.Current.GetService<IAppConfigService>();

IApplicationInfoService applicationInfoService = 
	Engine.Current.GetService<IApplicationInfoService>();

IAppResourceService appResourceService = 
	Engine.Current.GetService<IAppResourceService>();

IBroadcastService broadcastService = 
	Engine.Current.GetService<IBroadcastService>();

ICallerContextService callerContextService = 
	Engine.Current.GetService<ICallerContextService>();

ICodeLibraryService codeLibraryService = 
	Engine.Current.GetService<ICodeLibraryService>();

IComponentService componentService = 
	Engine.Current.GetService<IComponentService>();

ICubePerspectiveService cubePerspectiveService = 
	Engine.Current.GetService<ICubePerspectiveService>();

ICustomAttributeService customAttributeService = 
	Engine.Current.GetService<ICustomAttributeService>();

IDataConnectorService dataConnectorService = 
	Engine.Current.GetService<IDataConnectorService>();

IDataCubeService dataCubeService = 
	Engine.Current.GetService<IDataCubeService>();

IDataInputService dataInputService = 
	Engine.Current.GetService<IDataInputService>();

IDataProviderService dataProviderService = 
	Engine.Current.GetService<IDataProviderService>();

IDataRetrievalService dataRetrievalService = 
	Engine.Current.GetService<IDataRetrievalService>();

IDataSourceCredentialService dataSourceCredentialService = 
	Engine.Current.GetService<IDataSourceCredentialService>();

IDateMappingService dateMappingService = 
	Engine.Current.GetService<IDateMappingService>();

IDeliveryProviderService deliveryProviderService = 
	Engine.Current.GetService<IDeliveryProviderService>();

IDeliveryService deliveryService = 
	Engine.Current.GetService<IDeliveryService>();

IEmailService emailService = 
	Engine.Current.GetService<IEmailService>();

IEncryptionService encryptionService = 
	Engine.Current.GetService<IEncryptionService>();

IEventHookService eventHookService = 
	Engine.Current.GetService<IEventHookService>();

IExportProviderService exportProviderService = 
	Engine.Current.GetService<IExportProviderService>();

IExportService exportService = 
	Engine.Current.GetService<IExportService>();

IExtensionService extensionService = 
	Engine.Current.GetService<IExtensionService>();

IFeatureService featureService = 
	Engine.Current.GetService<IFeatureService>();

IFederatedAuthenticationService federatedAuthenticationService = 
	Engine.Current.GetService<IFederatedAuthenticationService>();

IFileSystemService fileSystemService = 
	Engine.Current.GetService<IFileSystemService>();

IGroupService groupService = 
	Engine.Current.GetService<IGroupService>();

IHealthService healthService = 
	Engine.Current.GetService<IHealthService>();

IHierarchyService hierarchyService = 
	Engine.Current.GetService<IHierarchyService>();

IHttpClientService httpClientService = 
	Engine.Current.GetService<IHttpClientService>();

IJobService jobService = 
	Engine.Current.GetService<IJobService>();

ILicenseActivationService licenseActivationService = 
	Engine.Current.GetService<ILicenseActivationService>();

ILicenseService licenseService = 
	Engine.Current.GetService<ILicenseService>();

ILocalizationService localizationService = 
	Engine.Current.GetService<ILocalizationService>();

ILoggingService loggingService = 
	Engine.Current.GetService<ILoggingService>();

ILogOnService logOnService = 
	Engine.Current.GetService<ILogOnService>();

IMachineLearningService machineLearningService = 
	Engine.Current.GetService<IMachineLearningService>();

IMapService mapService = 
	Engine.Current.GetService<IMapService>();

IMetadataService metadataService = 
	Engine.Current.GetService<IMetadataService>();

IMetricSetService metricSetService = 
	Engine.Current.GetService<IMetricSetService>();

IMultiTenancyService multiTenancyService = 
	Engine.Current.GetService<IMultiTenancyService>();

INativeStructureService nativeStructureService = 
	Engine.Current.GetService<INativeStructureService>();

INetworkHelperService networkHelperService = 
	Engine.Current.GetService<INetworkHelperService>();

INotificationService notificationService = 
	Engine.Current.GetService<INotificationService>();

IOlapCubeService olapCubeService = 
	Engine.Current.GetService<IOlapCubeService>();

IParameterService parameterService = 
	Engine.Current.GetService<IParameterService>();

IPrivilegeService privilegeService = 
	Engine.Current.GetService<IPrivilegeService>();

IProjectService projectService = 
	Engine.Current.GetService<IProjectService>();

IRaggedHierarchyService raggedHierarchyService = 
	Engine.Current.GetService<IRaggedHierarchyService>();

IRelationshipService relationshipService = 
	Engine.Current.GetService<IRelationshipService>();

IResourceFileService resourceFileService = 
	Engine.Current.GetService<IResourceFileService>();

IScheduleService scheduleService = 
	Engine.Current.GetService<IScheduleService>();

IServerRegistryService serverRegistryService = 
	Engine.Current.GetService<IServerRegistryService>();

ISessionService sessionService = 
	Engine.Current.GetService<ISessionService>();

IShortLinkService shortLinkService = 
	Engine.Current.GetService<IShortLinkService>();

ISlideshowService slideshowService = 
	Engine.Current.GetService<ISlideshowService>();

IStyleService styleService = 
	Engine.Current.GetService<IStyleService>();

IThemeService themeService = 
	Engine.Current.GetService<IThemeService>();

ITimeDimensionProviderService timeDimensionProviderService = 
	Engine.Current.GetService<ITimeDimensionProviderService>();

ITimeDimensionService timeDimensionService = 
	Engine.Current.GetService<ITimeDimensionService>();

ITokenService tokenService = 
	Engine.Current.GetService<ITokenService>();

ITransferService transferService = 
	Engine.Current.GetService<ITransferService>();

IUsageTrackingService usageTrackingService = 
	Engine.Current.GetService<IUsageTrackingService>();

IUserHierarchyService userHierarchyService = 
	Engine.Current.GetService<IUserHierarchyService>();

IViewService viewService = 
	Engine.Current.GetService<IViewService>();

IWebLinkService webLinkService = 
	Engine.Current.GetService<IWebLinkService>();